Developer Configuration

Get the developer configuration JSON schema

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

403

Forbidden - Requires role: owner, member, application

No content

get/sfp/api/devconfig/schema

HTTPcURLJavaScriptPython

GET /sfp/api/devconfig/schema HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

403

Forbidden - Requires role: owner, member, application

No content

List the stored developer configurations for a repository

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

repositoryIdentifierstringRequired

Repository identifier in format owner/repo

Example: flxbl-io/sf-core

Responses

200Success

application/json

repositoryIdentifierstringRequired

Repository identifier

403

Forbidden - Requires role: owner, member, application

get/sfp/api/devconfig/stored

HTTPcURLJavaScriptPython

GET /sfp/api/devconfig/stored?repositoryIdentifier=flxbl-io%2Fsf-core HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "repositoryIdentifier": "text",
  "configs": [
    {
      "config": "text",
      "version": 1,
      "defaultAccessLevel": "text",
      "accessLevels": [
        "text"
      ],
      "sourcePath": "text"
    }
  ]
}

Get a stored developer configuration for a repository

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

repositoryIdentifierstringRequired

Repository identifier in format owner/repo

Example: flxbl-io/sf-core

configstringOptional

Named configuration to address. A repository stores one configuration per devconfig file (persona); omitting the name addresses 'default', which is also where configurations stored before names existed appear.

Example: PO_ClientOpsconfig

Responses

200Success

application/json

repositoryIdentifierstringRequired

Repository identifier

configstringRequired

Name of the stored configuration

Example: PO_ClientOpsconfig

devconfigobjectRequired

Authoritative developer configuration block

versionnumberRequired

Optimistic concurrency version

sourcePathstringOptional

Repository file the configuration was imported from

403

Forbidden - Requires role: owner, member, application

404

The named configuration is not stored for the repository

get/sfp/api/devconfig

HTTPcURLJavaScriptPython

GET /sfp/api/devconfig?repositoryIdentifier=flxbl-io%2Fsf-core HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "repositoryIdentifier": "text",
  "config": "PO_ClientOpsconfig",
  "devconfig": {},
  "version": 1,
  "sourcePath": "text"
}

Create or update a stored developer configuration

post

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

repositoryIdentifierstringRequired

Repository identifier in format owner/repo

Example: flxbl-io/sf-core

configstringOptional

Named configuration to address. A repository stores one configuration per devconfig file (persona); omitting the name addresses 'default', which is also where configurations stored before names existed appear.

Example: PO_ClientOpsconfig

Body

application/json

devconfigobjectRequired

Developer configuration block containing defaultAccessLevel and accessLevels

versionnumberOptional

Current document version when updating an existing configuration

Responses

200Success

application/json

repositoryIdentifierstringRequired

Repository identifier

configstringRequired

Name of the stored configuration

Example: PO_ClientOpsconfig

devconfigobjectRequired

Authoritative developer configuration block

versionnumberRequired

Optimistic concurrency version

sourcePathstringOptional

Repository file the configuration was imported from

403

Forbidden - Requires role: owner, application

post/sfp/api/devconfig

HTTPcURLJavaScriptPython

POST /sfp/api/devconfig?repositoryIdentifier=flxbl-io%2Fsf-core HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "devconfig": {},
  "version": 1
}

{
  "repositoryIdentifier": "text",
  "config": "PO_ClientOpsconfig",
  "devconfig": {},
  "version": 1,
  "sourcePath": "text"
}

Replace a stored developer configuration

put

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

repositoryIdentifierstringRequired

Repository identifier in format owner/repo

Example: flxbl-io/sf-core

configstringOptional

Named configuration to address. A repository stores one configuration per devconfig file (persona); omitting the name addresses 'default', which is also where configurations stored before names existed appear.

Example: PO_ClientOpsconfig

Body

application/json

devconfigobjectRequired

Developer configuration block containing defaultAccessLevel and accessLevels

versionnumberOptional

Current document version when updating an existing configuration

Responses

200Success

application/json

repositoryIdentifierstringRequired

Repository identifier

configstringRequired

Name of the stored configuration

Example: PO_ClientOpsconfig

devconfigobjectRequired

Authoritative developer configuration block

versionnumberRequired

Optimistic concurrency version

sourcePathstringOptional

Repository file the configuration was imported from

403

Forbidden - Requires role: owner, application

put/sfp/api/devconfig

HTTPcURLJavaScriptPython

PUT /sfp/api/devconfig?repositoryIdentifier=flxbl-io%2Fsf-core HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "devconfig": {},
  "version": 1
}

{
  "repositoryIdentifier": "text",
  "config": "PO_ClientOpsconfig",
  "devconfig": {},
  "version": 1,
  "sourcePath": "text"
}

Delete a stored developer configuration

delete

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

repositoryIdentifierstringRequired

Repository identifier in format owner/repo

Example: flxbl-io/sf-core

configstringOptional

Named configuration to address. A repository stores one configuration per devconfig file (persona); omitting the name addresses 'default', which is also where configurations stored before names existed appear.

Example: PO_ClientOpsconfig

Responses

403

Forbidden - Requires role: owner

No content

delete/sfp/api/devconfig

HTTPcURLJavaScriptPython

DELETE /sfp/api/devconfig?repositoryIdentifier=flxbl-io%2Fsf-core HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

403

Forbidden - Requires role: owner

No content

List the developer configurations discoverable on a repository branch

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

repositoryIdentifierstringRequired

Repository identifier in format owner/repo

Example: flxbl-io/sf-core

branchstringRequired

Repository branch to read the configurations from

Example: main

Responses

200Success

application/json

branchstringRequired

Branch the configurations were read from

403

Forbidden - Requires role: owner

get/sfp/api/devconfig/repository-configs

HTTPcURLJavaScriptPython

GET /sfp/api/devconfig/repository-configs?repositoryIdentifier=flxbl-io%2Fsf-core&branch=main HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "branch": "text",
  "configs": [
    {
      "path": "text",
      "accessLevels": [
        "text"
      ]
    }
  ]
}

Import a repository devconfig file as its own named stored configuration; re-importing refreshes it

post

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

repositoryIdentifierstringRequired

Repository identifier in format owner/repo

Example: flxbl-io/sf-core

Body

application/json

branchstringRequired

Repository branch to import the developer configuration from

Example: main

pathstringOptional

Path of the configuration to import. Required only when the branch holds more than one; omit it when there is exactly one.

Example: config/devconfig.yaml

Responses

200Success

application/json

repositoryIdentifierstringRequired

Repository identifier

configstringRequired

Name of the stored configuration

Example: PO_ClientOpsconfig

devconfigobjectRequired

Authoritative developer configuration block

versionnumberRequired

Optimistic concurrency version

sourcePathstringOptional

Repository file the configuration was imported from

403

Forbidden - Requires role: owner

post/sfp/api/devconfig/import

HTTPcURLJavaScriptPython

POST /sfp/api/devconfig/import?repositoryIdentifier=flxbl-io%2Fsf-core HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "branch": "main",
  "path": "config/devconfig.yaml"
}

{
  "repositoryIdentifier": "text",
  "config": "PO_ClientOpsconfig",
  "devconfig": {},
  "version": 1,
  "sourcePath": "text"
}