Config and swagger upgrade
This commit is contained in:
ycc
@@ -1,34 +1,20 @@
|
||||
{
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"title": "beego Test API",
|
||||
"description": "beego has a very cool tools to autogenerate documents for your API\n",
|
||||
"title": "oc-auth",
|
||||
"description": "OpenCloud authentication services\n",
|
||||
"version": "1.0.0",
|
||||
"termsOfService": "http://beego.me/",
|
||||
"termsOfService": "http://cloud.o-forge.io/",
|
||||
"contact": {
|
||||
"email": "astaxie@gmail.com"
|
||||
"email": "admin@o-cloud.io"
|
||||
},
|
||||
"license": {
|
||||
"name": "Apache 2.0",
|
||||
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
|
||||
"name": "MIT",
|
||||
"url": "https://opensource.org/license/mit"
|
||||
}
|
||||
},
|
||||
"basePath": "/oc",
|
||||
"paths": {
|
||||
"/version/": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"version"
|
||||
],
|
||||
"description": "get version\n\u003cbr\u003e",
|
||||
"operationId": "VersionController.GetAll",
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": ""
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/auth/": {
|
||||
"post": {
|
||||
"tags": [
|
||||
@@ -60,6 +46,32 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/auth/discover/{url}": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"auth"
|
||||
],
|
||||
"description": "find auth by authid\n\u003cbr\u003e",
|
||||
"operationId": "AuthController.Get",
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "authId",
|
||||
"description": "the authid you want to get",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "{auth} models.auth"
|
||||
},
|
||||
"403": {
|
||||
"description": ":authId is empty"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/auth/find/{query}": {
|
||||
"get": {
|
||||
"tags": [
|
||||
@@ -135,9 +147,72 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/registration/": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"registration"
|
||||
],
|
||||
"description": "create auths\n\u003cbr\u003e",
|
||||
"operationId": "RegistrationController.Create",
|
||||
"parameters": [
|
||||
{
|
||||
"in": "body",
|
||||
"name": "body",
|
||||
"description": "The app info",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"$ref": "#/definitions/models.Application"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "{string} models.auth.Id"
|
||||
},
|
||||
"403": {
|
||||
"description": "body is empty"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/version/": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"version"
|
||||
],
|
||||
"description": "get version\n\u003cbr\u003e",
|
||||
"operationId": "VersionController.GetAll",
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": ""
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"definitions": {
|
||||
"models.Application": {
|
||||
"title": "Application",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"access_token": {
|
||||
"type": "string"
|
||||
},
|
||||
"callback_url": {
|
||||
"type": "string"
|
||||
},
|
||||
"client_id": {
|
||||
"type": "string"
|
||||
},
|
||||
"client_name": {
|
||||
"type": "string"
|
||||
},
|
||||
"client_secret": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"models.auth": {
|
||||
"title": "auth",
|
||||
"type": "object"
|
||||
@@ -148,6 +223,10 @@
|
||||
"name": "auth",
|
||||
"description": "Operations about auth\n"
|
||||
},
|
||||
{
|
||||
"name": "registration",
|
||||
"description": "Operations about auth\n"
|
||||
},
|
||||
{
|
||||
"name": "version",
|
||||
"description": "VersionController operations for Version\n"
|
||||
|
||||
@@ -1,28 +1,17 @@
|
||||
swagger: "2.0"
|
||||
info:
|
||||
title: beego Test API
|
||||
title: oc-auth
|
||||
description: |
|
||||
beego has a very cool tools to autogenerate documents for your API
|
||||
OpenCloud authentication services
|
||||
version: 1.0.0
|
||||
termsOfService: http://beego.me/
|
||||
termsOfService: http://cloud.o-forge.io/
|
||||
contact:
|
||||
email: astaxie@gmail.com
|
||||
email: admin@o-cloud.io
|
||||
license:
|
||||
name: Apache 2.0
|
||||
url: http://www.apache.org/licenses/LICENSE-2.0.html
|
||||
name: MIT
|
||||
url: https://opensource.org/license/mit
|
||||
basePath: /oc
|
||||
paths:
|
||||
/version/:
|
||||
get:
|
||||
tags:
|
||||
- version
|
||||
description: |-
|
||||
get version
|
||||
<br>
|
||||
operationId: VersionController.GetAll
|
||||
responses:
|
||||
"200":
|
||||
description: ""
|
||||
/auth/:
|
||||
post:
|
||||
tags:
|
||||
@@ -82,6 +71,25 @@ paths:
|
||||
description: '{string} delete success!'
|
||||
"403":
|
||||
description: authId is empty
|
||||
/auth/discover/{url}:
|
||||
get:
|
||||
tags:
|
||||
- auth
|
||||
description: |-
|
||||
find auth by authid
|
||||
<br>
|
||||
operationId: AuthController.Get
|
||||
parameters:
|
||||
- in: path
|
||||
name: authId
|
||||
description: the authid you want to get
|
||||
required: true
|
||||
type: string
|
||||
responses:
|
||||
"200":
|
||||
description: '{auth} models.auth'
|
||||
"403":
|
||||
description: :authId is empty
|
||||
/auth/find/{query}:
|
||||
get:
|
||||
tags:
|
||||
@@ -101,7 +109,52 @@ paths:
|
||||
description: '{auths} []models.auth'
|
||||
"403":
|
||||
description: ""
|
||||
/registration/:
|
||||
post:
|
||||
tags:
|
||||
- registration
|
||||
description: |-
|
||||
create auths
|
||||
<br>
|
||||
operationId: RegistrationController.Create
|
||||
parameters:
|
||||
- in: body
|
||||
name: body
|
||||
description: The app info
|
||||
required: true
|
||||
schema:
|
||||
$ref: '#/definitions/models.Application'
|
||||
responses:
|
||||
"200":
|
||||
description: '{string} models.auth.Id'
|
||||
"403":
|
||||
description: body is empty
|
||||
/version/:
|
||||
get:
|
||||
tags:
|
||||
- version
|
||||
description: |-
|
||||
get version
|
||||
<br>
|
||||
operationId: VersionController.GetAll
|
||||
responses:
|
||||
"200":
|
||||
description: ""
|
||||
definitions:
|
||||
models.Application:
|
||||
title: Application
|
||||
type: object
|
||||
properties:
|
||||
access_token:
|
||||
type: string
|
||||
callback_url:
|
||||
type: string
|
||||
client_id:
|
||||
type: string
|
||||
client_name:
|
||||
type: string
|
||||
client_secret:
|
||||
type: string
|
||||
models.auth:
|
||||
title: auth
|
||||
type: object
|
||||
@@ -109,6 +162,9 @@ tags:
|
||||
- name: auth
|
||||
description: |
|
||||
Operations about auth
|
||||
- name: registration
|
||||
description: |
|
||||
Operations about auth
|
||||
- name: version
|
||||
description: |
|
||||
VersionController operations for Version
|
||||
|
||||
Reference in New Issue
Block a user