Advertisement
Not a member of Pastebin yet?
Sign Up,
it unlocks many cool features!
- swagger: "2.0"
- info:
- description: "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters."
- version: "1.0.0"
- title: "Swagger Petstore"
- termsOfService: "http://swagger.io/terms/"
- contact:
- email: "apiteam@swagger.io"
- license:
- name: "Apache 2.0"
- url: "http://www.apache.org/licenses/LICENSE-2.0.html"
- host: "dados.ufrn.br"
- basePath: "/api/3/action/"
- tags:
- - name: "DataSet"
- description: "Everything about your DataSet"
- externalDocs:
- description: "Find out more"
- url: "http://swagger.io"
- - name: "store"
- description: "Access to Petstore orders"
- - name: "user"
- description: "Operations about user"
- externalDocs:
- description: "Find out more about our store"
- url: "http://swagger.io"
- schemes:
- - "http"
- paths:
- /package_list:
- get:
- tags:
- - "DataSet"
- summary: "Retorna uma lista dos nomes dos conjuntos de dados do site"
- description: "Retorna uma lista dos nomes dos conjuntos de dados do site (pacotes)."
- operationId: ""
- consumes:
- - "application/json"
- - "application/xml"
- produces:
- - "application/json"
- parameters:
- - in: "body"
- name: "limit"
- description: "se fornecido, a lista de conjuntos de dados será dividida em páginas de no máximo conjuntos de dados por página e somente uma página será retornada por vez."
- required: false
- schema:
- $ref: "#/definitions/DataSet"
- responses:
- 200:
- description: "successful operation"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/DataSet"
- 400:
- description: "Invalid status value"
- 404:
- description: "Invalid resource_id"
- security:
- - petstore_auth:
- - "write:pets"
- - "read:pets"
- /datastore_search/{resource_id}:
- get:
- tags:
- - "DataSet"
- summary: "Finds datasets by UFRN"
- description: "Multiple status values can be provided with comma separated strings"
- operationId: "findPetsByStatus"
- produces:
- - "application/xml"
- - "application/json"
- parameters:
- - name: "resource_id"
- in: "path"
- description: "ID of dateSet"
- required: true
- type: "string"
- format: "int64"
- responses:
- 200:
- description: "successful operation"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/DataSet"
- 400:
- description: "Invalid status value"
- 404:
- description: "Invalid resource_id"
- security:
- - petstore_auth:
- - "write:pets"
- - "read:pets"
- /resource_view_show/{id}:
- get:
- tags:
- - "DataSet"
- summary: ""
- description: "Retorna os metadados de uma 'resource_view'"
- operationId: "findResourceById"
- produces:
- - "application/xml"
- - "application/json"
- parameters:
- - name: "id"
- in: "path"
- description: "ID of resource_view"
- required: true
- type: "string"
- format: "int64"
- responses:
- 200:
- description: "successful operation"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/DataSet"
- 400:
- description: "Invalid status value"
- 404:
- description: "Invalid id"
- security:
- - petstore_auth:
- - "write:pets"
- - "read:pets"
- /resource_view_list/{id}:
- get:
- tags:
- - "DataSet"
- summary: ""
- description: "Retorna os metadados de uma 'resource_view'"
- produces:
- - "application/xml"
- - "application/json"
- parameters:
- - name: "id"
- in: "path"
- description: "ID of resource_view"
- required: true
- type: "string"
- format: "int64"
- responses:
- 200:
- description: "successful operation"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/DataSet"
- 400:
- description: "Invalid status value"
- 404:
- description: "Invalid id"
- security:
- - petstore_auth:
- - "write:pets"
- - "read:pets"
- /revision_show/{id}:
- get:
- tags:
- - "DataSet"
- summary: ""
- description: "Retorna os detalhes de uma revisão"
- produces:
- - "application/xml"
- - "application/json"
- parameters:
- - name: "id"
- in: "path"
- description: "ID of review"
- required: true
- type: "string"
- format: "int64"
- responses:
- 200:
- description: "successful operation"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/DataSet"
- 400:
- description: "Invalid status value"
- 404:
- description: "Invalid id"
- security:
- - petstore_auth:
- - "write:pets"
- - "read:pets"
- /group_show/:
- get:
- tags:
- - "DataSet"
- summary: ""
- description: "Retorna os detalhes de uma revisão"
- produces:
- - "application/xml"
- - "application/json"
- parameters:
- - name: "id"
- in: "query"
- description: "ID of review"
- required: false
- type: "string"
- format: "int64"
- responses:
- 200:
- description: "successful operation"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/DataSet"
- 400:
- description: "Invalid status value"
- 404:
- description: "Invalid id"
- security:
- - petstore_auth:
- - "write:pets"
- - "read:pets"
- /organization_show/:
- get:
- tags:
- - "DataSet"
- summary: ""
- description: "Retorna os detalhes de uma organização"
- produces:
- - "application/xml"
- - "application/json"
- parameters:
- - name: "id"
- in: "path"
- description: "ID ou nome da organização"
- required: true
- type: "string"
- format: "int64"
- responses:
- 200:
- description: "successful operation"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/DataSet"
- 400:
- description: "Invalid status value"
- 404:
- description: "Invalid id"
- security:
- - petstore_auth:
- - "write:pets"
- - "read:pets"
- /group_package_show/:
- get:
- tags:
- - "DataSet"
- summary: ""
- description: "Retorna os dataSets de um grupo"
- produces:
- - "application/xml"
- - "application/json"
- parameters:
- - name: "id"
- in: "path"
- description: "ID ou nome do grupo"
- required: true
- type: "string"
- format: "int64"
- responses:
- 200:
- description: "successful operation"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/DataSet"
- 400:
- description: "Invalid status value"
- 404:
- description: "Invalid id"
- security:
- - petstore_auth:
- - "write:pets"
- - "read:pets"
- /tag_show/:
- get:
- tags:
- - "DataSet"
- summary: ""
- description: "Retorna detalhes de uma tag e todos os datasets assossiados a ela"
- produces:
- - "application/xml"
- - "application/json"
- parameters:
- - name: "id"
- in: "path"
- description: "ID ou nome da tag"
- required: true
- type: "string"
- format: "int64"
- responses:
- 200:
- description: "successful operation"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/DataSet"
- 400:
- description: "Invalid status value"
- 404:
- description: "Invalid id"
- security:
- - petstore_auth:
- - "write:pets"
- - "read:pets"
- /package_search/:
- get:
- tags:
- - "DataSet"
- summary: "Procura pacotes que satisfaçam um determinado critério de pesquisa"
- description: "Essa ação aceita parâmetros de consulta de pesquisa de solr (detalhes abaixo) e retorna um dicionário de resultados, incluindo conjuntos de dados ditados que correspondem aos critérios de pesquisa, uma contagem de pesquisa e também informações de faceta."
- produces:
- - "application/xml"
- - "application/json"
- parameters:
- - name: "id"
- in: "path"
- description: "Esta ação aceita um subconjunto de parâmetros de consulta de pesquisa do solr"
- required: true
- type: "string"
- format: "int64"
- responses:
- 200:
- description: "successful operation"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/DataSet"
- 400:
- description: "Invalid status value"
- 404:
- description: "Invalid id"
- security:
- - petstore_auth:
- - "write:pets"
- - "read:pets"
- securityDefinitions:
- petstore_auth:
- type: "oauth2"
- authorizationUrl: "http://petstore.swagger.io/oauth/dialog"
- flow: "implicit"
- scopes:
- write:pets: "modify pets in your account"
- read:pets: "read your pets"
- api_key:
- type: "apiKey"
- name: "api_key"
- in: "header"
- definitions:
- Order:
- type: "object"
- properties:
- id:
- type: "integer"
- format: "int64"
- petId:
- type: "integer"
- format: "int64"
- quantity:
- type: "integer"
- format: "int32"
- shipDate:
- type: "string"
- format: "date-time"
- status:
- type: "string"
- description: "Order Status"
- enum:
- - "placed"
- - "approved"
- - "delivered"
- complete:
- type: "boolean"
- default: false
- xml:
- name: "Order"
- Category:
- type: "object"
- properties:
- id:
- type: "integer"
- format: "int64"
- name:
- type: "string"
- xml:
- name: "Category"
- User:
- type: "object"
- properties:
- id:
- type: "integer"
- format: "int64"
- username:
- type: "string"
- firstName:
- type: "string"
- lastName:
- type: "string"
- email:
- type: "string"
- password:
- type: "string"
- phone:
- type: "string"
- userStatus:
- type: "integer"
- format: "int32"
- description: "User Status"
- xml:
- name: "User"
- Tag:
- type: "object"
- properties:
- id:
- type: "integer"
- format: "int64"
- name:
- type: "string"
- xml:
- name: "Tag"
- DataSet:
- type: "object"
- required:
- - "name"
- - "photoUrls"
- properties:
- help:
- type: "string"
- example: "http://dados.ufrn.br/api/3/action/help_show?name=datastore_search"
- sucess:
- type: "boolean"
- fields:
- type: "array"
- items:
- $ref: "#/definitions/Tag"
- name:
- type: "string"
- example: "DataSet"
- photoUrls:
- type: "array"
- xml:
- name: "photoUrl"
- wrapped: true
- items:
- type: "string"
- tags:
- type: "array"
- xml:
- name: "tag"
- wrapped: true
- items:
- $ref: "#/definitions/Tag"
- status:
- type: "string"
- description: "pet status in the store"
- enum:
- - "available"
- - "pending"
- - "sold"
- xml:
- name: "Pet"
- ApiResponse:
- type: "object"
- properties:
- code:
- type: "integer"
- format: "int32"
- type:
- type: "string"
- message:
- type: "string"
- externalDocs:
- description: "Find out more about Swagger"
- url: "http://swagger.io"
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement