> For the complete documentation index, see [llms.txt](https://docs.flxbl.io/flxbl/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flxbl.io/flxbl/sfp-server/api-reference/developer-configuration.md). # Developer Configuration ## GET /sfp/api/devconfig/schema > Get the developer configuration JSON schema ```json {"openapi":"3.0.0","info":{"title":"sfp server","version":"52.12.0"},"security":[{"access-token":[]}],"components":{"securitySchemes":{"access-token":{"scheme":"bearer","bearerFormat":"JWT","type":"http","in":"header"}}},"paths":{"/sfp/api/devconfig/schema":{"get":{"operationId":"DevConfigController_getSchema","summary":"Get the developer configuration JSON schema","parameters":[],"responses":{"403":{"description":"Forbidden - Requires role: owner, member, application"}},"tags":["Developer Configuration"]}}}} ``` ## GET /sfp/api/devconfig/stored > List the stored developer configurations for a repository ```json {"openapi":"3.0.0","info":{"title":"sfp server","version":"52.12.0"},"security":[{"access-token":[]}],"components":{"securitySchemes":{"access-token":{"scheme":"bearer","bearerFormat":"JWT","type":"http","in":"header"}},"schemas":{"StoredDevConfigsResponseDto":{"type":"object","properties":{"repositoryIdentifier":{"type":"string","description":"Repository identifier"},"configs":{"description":"Stored configurations for the repository","type":"array","items":{"$ref":"#/components/schemas/StoredDevConfigSummaryDto"}}},"required":["repositoryIdentifier","configs"]},"StoredDevConfigSummaryDto":{"type":"object","properties":{"config":{"type":"string","description":"Name of the stored configuration"},"version":{"type":"number","description":"Optimistic concurrency version"},"defaultAccessLevel":{"type":"string","description":"Access level a de-elevated user is restored to"},"accessLevels":{"description":"Named access levels the configuration declares","type":"array","items":{"type":"string"}},"sourcePath":{"type":"string","description":"Repository file the configuration was imported from"}},"required":["config","version","defaultAccessLevel","accessLevels"]}}},"paths":{"/sfp/api/devconfig/stored":{"get":{"operationId":"DevConfigController_listStored","summary":"List the stored developer configurations for a repository","parameters":[{"name":"repositoryIdentifier","required":true,"in":"query","description":"Repository identifier in format owner/repo","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoredDevConfigsResponseDto"}}}},"403":{"description":"Forbidden - Requires role: owner, member, application"}},"tags":["Developer Configuration"]}}}} ``` ## GET /sfp/api/devconfig > Get a stored developer configuration for a repository ```json {"openapi":"3.0.0","info":{"title":"sfp server","version":"52.12.0"},"security":[{"access-token":[]}],"components":{"securitySchemes":{"access-token":{"scheme":"bearer","bearerFormat":"JWT","type":"http","in":"header"}},"schemas":{"DevConfigResponseDto":{"type":"object","properties":{"repositoryIdentifier":{"type":"string","description":"Repository identifier"},"config":{"type":"string","description":"Name of the stored configuration"},"devconfig":{"type":"object","description":"Authoritative developer configuration block"},"version":{"type":"number","description":"Optimistic concurrency version"},"sourcePath":{"type":"string","description":"Repository file the configuration was imported from"}},"required":["repositoryIdentifier","config","devconfig","version"]}}},"paths":{"/sfp/api/devconfig":{"get":{"operationId":"DevConfigController_getDevConfig","summary":"Get a stored developer configuration for a repository","parameters":[{"name":"repositoryIdentifier","required":true,"in":"query","description":"Repository identifier in format owner/repo","schema":{"type":"string"}},{"name":"config","required":false,"in":"query","description":"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.","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DevConfigResponseDto"}}}},"403":{"description":"Forbidden - Requires role: owner, member, application"},"404":{"description":"The named configuration is not stored for the repository"}},"tags":["Developer Configuration"]}}}} ``` ## POST /sfp/api/devconfig > Create or update a stored developer configuration ```json {"openapi":"3.0.0","info":{"title":"sfp server","version":"52.12.0"},"security":[{"access-token":[]}],"components":{"securitySchemes":{"access-token":{"scheme":"bearer","bearerFormat":"JWT","type":"http","in":"header"}},"schemas":{"SaveDevConfigDto":{"type":"object","properties":{"devconfig":{"type":"object","description":"Developer configuration block containing defaultAccessLevel and accessLevels"},"version":{"type":"number","description":"Current document version when updating an existing configuration"}},"required":["devconfig"]},"DevConfigResponseDto":{"type":"object","properties":{"repositoryIdentifier":{"type":"string","description":"Repository identifier"},"config":{"type":"string","description":"Name of the stored configuration"},"devconfig":{"type":"object","description":"Authoritative developer configuration block"},"version":{"type":"number","description":"Optimistic concurrency version"},"sourcePath":{"type":"string","description":"Repository file the configuration was imported from"}},"required":["repositoryIdentifier","config","devconfig","version"]}}},"paths":{"/sfp/api/devconfig":{"post":{"operationId":"DevConfigController_createOrUpdateDevConfig","summary":"Create or update a stored developer configuration","parameters":[{"name":"repositoryIdentifier","required":true,"in":"query","description":"Repository identifier in format owner/repo","schema":{"type":"string"}},{"name":"config","required":false,"in":"query","description":"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.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveDevConfigDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DevConfigResponseDto"}}}},"403":{"description":"Forbidden - Requires role: owner, application"}},"tags":["Developer Configuration"]}}}} ``` ## PUT /sfp/api/devconfig > Replace a stored developer configuration ```json {"openapi":"3.0.0","info":{"title":"sfp server","version":"52.12.0"},"security":[{"access-token":[]}],"components":{"securitySchemes":{"access-token":{"scheme":"bearer","bearerFormat":"JWT","type":"http","in":"header"}},"schemas":{"SaveDevConfigDto":{"type":"object","properties":{"devconfig":{"type":"object","description":"Developer configuration block containing defaultAccessLevel and accessLevels"},"version":{"type":"number","description":"Current document version when updating an existing configuration"}},"required":["devconfig"]},"DevConfigResponseDto":{"type":"object","properties":{"repositoryIdentifier":{"type":"string","description":"Repository identifier"},"config":{"type":"string","description":"Name of the stored configuration"},"devconfig":{"type":"object","description":"Authoritative developer configuration block"},"version":{"type":"number","description":"Optimistic concurrency version"},"sourcePath":{"type":"string","description":"Repository file the configuration was imported from"}},"required":["repositoryIdentifier","config","devconfig","version"]}}},"paths":{"/sfp/api/devconfig":{"put":{"operationId":"DevConfigController_replaceDevConfig","summary":"Replace a stored developer configuration","parameters":[{"name":"repositoryIdentifier","required":true,"in":"query","description":"Repository identifier in format owner/repo","schema":{"type":"string"}},{"name":"config","required":false,"in":"query","description":"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.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveDevConfigDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DevConfigResponseDto"}}}},"403":{"description":"Forbidden - Requires role: owner, application"}},"tags":["Developer Configuration"]}}}} ``` ## DELETE /sfp/api/devconfig > Delete a stored developer configuration ```json {"openapi":"3.0.0","info":{"title":"sfp server","version":"52.12.0"},"security":[{"access-token":[]}],"components":{"securitySchemes":{"access-token":{"scheme":"bearer","bearerFormat":"JWT","type":"http","in":"header"}}},"paths":{"/sfp/api/devconfig":{"delete":{"operationId":"DevConfigController_deleteDevConfig","summary":"Delete a stored developer configuration","parameters":[{"name":"repositoryIdentifier","required":true,"in":"query","description":"Repository identifier in format owner/repo","schema":{"type":"string"}},{"name":"config","required":false,"in":"query","description":"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.","schema":{"type":"string"}}],"responses":{"403":{"description":"Forbidden - Requires role: owner"}},"tags":["Developer Configuration"]}}}} ``` ## GET /sfp/api/devconfig/repository-configs > List the developer configurations discoverable on a repository branch ```json {"openapi":"3.0.0","info":{"title":"sfp server","version":"52.12.0"},"security":[{"access-token":[]}],"components":{"securitySchemes":{"access-token":{"scheme":"bearer","bearerFormat":"JWT","type":"http","in":"header"}},"schemas":{"RepositoryDevConfigsResponseDto":{"type":"object","properties":{"branch":{"type":"string","description":"Branch the configurations were read from"},"configs":{"description":"Developer configurations found on the branch","type":"array","items":{"$ref":"#/components/schemas/RepositoryDevConfigDto"}}},"required":["branch","configs"]},"RepositoryDevConfigDto":{"type":"object","properties":{"path":{"type":"string","description":"Path of the configuration within the repository"},"accessLevels":{"description":"Named access levels the configuration declares","type":"array","items":{"type":"string"}}},"required":["path","accessLevels"]}}},"paths":{"/sfp/api/devconfig/repository-configs":{"get":{"operationId":"DevConfigController_listRepositoryConfigs","summary":"List the developer configurations discoverable on a repository branch","parameters":[{"name":"repositoryIdentifier","required":true,"in":"query","description":"Repository identifier in format owner/repo","schema":{"type":"string"}},{"name":"branch","required":true,"in":"query","description":"Repository branch to read the configurations from","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RepositoryDevConfigsResponseDto"}}}},"403":{"description":"Forbidden - Requires role: owner"}},"tags":["Developer Configuration"]}}}} ``` ## POST /sfp/api/devconfig/import > Import a repository devconfig file as its own named stored configuration; re-importing refreshes it ```json {"openapi":"3.0.0","info":{"title":"sfp server","version":"52.12.0"},"security":[{"access-token":[]}],"components":{"securitySchemes":{"access-token":{"scheme":"bearer","bearerFormat":"JWT","type":"http","in":"header"}},"schemas":{"ImportDevConfigDto":{"type":"object","properties":{"branch":{"type":"string","description":"Repository branch to import the developer configuration from"},"path":{"type":"string","description":"Path of the configuration to import. Required only when the branch holds more than one; omit it when there is exactly one."}},"required":["branch"]},"DevConfigResponseDto":{"type":"object","properties":{"repositoryIdentifier":{"type":"string","description":"Repository identifier"},"config":{"type":"string","description":"Name of the stored configuration"},"devconfig":{"type":"object","description":"Authoritative developer configuration block"},"version":{"type":"number","description":"Optimistic concurrency version"},"sourcePath":{"type":"string","description":"Repository file the configuration was imported from"}},"required":["repositoryIdentifier","config","devconfig","version"]}}},"paths":{"/sfp/api/devconfig/import":{"post":{"operationId":"DevConfigController_importFromRepository","summary":"Import a repository devconfig file as its own named stored configuration; re-importing refreshes it","parameters":[{"name":"repositoryIdentifier","required":true,"in":"query","description":"Repository identifier in format owner/repo","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportDevConfigDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DevConfigResponseDto"}}}},"403":{"description":"Forbidden - Requires role: owner"}},"tags":["Developer Configuration"]}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.flxbl.io/flxbl/sfp-server/api-reference/developer-configuration.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.