swagger: '2.0'
info:
title: Cloudsmith API (v1) audit-log namespaces API
description: The API to the Cloudsmith Service
termsOfService: https://help.cloudsmith.io
contact:
name: Cloudsmith Support
url: https://help.cloudsmith.io
email: support@cloudsmith.io
license:
name: MIT
url: https://opensource.org/licenses/MIT
version: v1
host: api.cloudsmith.io
basePath: /
schemes:
- https
consumes:
- application/json
produces:
- application/json
security:
- apikey: []
- basic: []
tags:
- name: namespaces
paths:
/namespaces/:
parameters: []
get:
operationId: namespaces_list
summary: Get a list of all namespaces the user belongs to.
description: Get a list of all namespaces the user belongs to.
parameters:
- name: page
in: query
description: A page number within the paginated result set.
required: false
type: integer
- name: page_size
in: query
description: Number of results to return per page.
required: false
type: integer
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/Namespace'
'400':
description: Request could not be processed (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
'422':
description: Missing or invalid parameters (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
tags:
- namespaces
/namespaces/{slug}/:
parameters:
- name: slug
in: path
required: true
type: string
get:
operationId: namespaces_read
summary: Get a specific namespace that the user belongs to.
description: Get a specific namespace that the user belongs to.
parameters: []
responses:
'200':
description: OK
schema:
$ref: '#/definitions/Namespace'
'400':
description: Request could not be processed (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
'422':
description: Missing or invalid parameters (see detail).
schema:
$ref: '#/definitions/ErrorDetail'
tags:
- namespaces
definitions:
ErrorDetail:
required:
- detail
type: object
properties:
detail:
title: Detail
description: An extended message for the response.
type: string
minLength: 1
fields:
title: Fields
description: 'A Dictionary of related errors where key: Field and value: Array of Errors related to that field'
type: object
additionalProperties:
type: array
items:
type: string
minLength: 1
Namespace:
type: object
properties:
name:
title: Name
type: string
readOnly: true
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
readOnly: true
slug_perm:
title: Slug perm
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
readOnly: true
minLength: 1
type_name:
title: Type name
type: string
readOnly: true
securityDefinitions:
apikey:
type: apiKey
name: X-Api-Key
in: header
basic:
type: basic