{"schemaVersion":"1.0","sourceCommit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca","sourceVisibility":"private","article":{"id":"api-mansoq-core-plugconfigviewset-64eee3f9","title":"Plug Config API reference · mansoq-core","summary":"Static source contract for Plug Config: 6 declared or inherited operation mappings, schema/field evidence and authorization/refusal references. Deployment and behavioral review remain explicit.","module":"IT & integrations","roles":["IT administrator","Developer","Integration engineer"],"facilities":["All configured facility types"],"kind":"reference","minutes":4,"prerequisites":["Use the API contract from the installed deployment and an authorized synthetic test environment.","Confirm facility/organization scope, action permissions and optional app enablement.","This reference is static source evidence; complete payload, authorization, failure and end-to-end review remains recorded as pending."],"steps":[],"sections":[{"title":"Declared route and availability","body":"This resource is declared in **mansoq-core** at `/api/v1/plug_config/`. verified core mount in config/urls.py A registered path and an indexed handler do not prove deployment availability, user permission or production readiness."},{"title":"Operation map","body":"| Method | Path | Action | Evidence |\n| --- | --- | --- | --- |\n| GET | `/api/v1/plug_config/` | list | declared/inherited method |\n| POST | `/api/v1/plug_config/` | create | standard external DRF mixin; library behavior review pending |\n| GET | `/api/v1/plug_config/{slug}/` | retrieve | standard external DRF mixin; library behavior review pending |\n| PUT | `/api/v1/plug_config/{slug}/` | update | standard external DRF mixin; library behavior review pending |\n| PATCH | `/api/v1/plug_config/{slug}/` | partial_update | standard external DRF mixin; library behavior review pending |\n| DELETE | `/api/v1/plug_config/{slug}/` | destroy | standard external DRF mixin; library behavior review pending |"},{"title":"list · GET","body":"**GET /api/v1/plug_config/** — action `list`. static contract extracted; runtime/permission/payload behavior review pending.\n\n**serializer: PlugConfigSerializer**. No statically declared scalar field list was resolved; inspect the schema graph and pinned source.\n\n**Authorization:** no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access."},{"title":"create · POST","body":"**POST /api/v1/plug_config/** — action `create`. static contract extracted; runtime/permission/payload behavior review pending.\n\n**serializer: PlugConfigSerializer**. No statically declared scalar field list was resolved; inspect the schema graph and pinned source.\n\n**Authorization:** no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access."},{"title":"retrieve · GET","body":"**GET /api/v1/plug_config/{slug}/** — action `retrieve`. static contract extracted; runtime/permission/payload behavior review pending.\n\nPath and deployment-context parameters:\n\n| Location | Parameter | Type | Required |\n| --- | --- | --- | --- |\n| path | slug | router lookup string; semantic ID validation requires handler/schema review | true |\n\n**serializer: PlugConfigSerializer**. No statically declared scalar field list was resolved; inspect the schema graph and pinned source.\n\n**Authorization:** no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access."},{"title":"update · PUT","body":"**PUT /api/v1/plug_config/{slug}/** — action `update`. static contract extracted; runtime/permission/payload behavior review pending.\n\nPath and deployment-context parameters:\n\n| Location | Parameter | Type | Required |\n| --- | --- | --- | --- |\n| path | slug | router lookup string; semantic ID validation requires handler/schema review | true |\n\n**serializer: PlugConfigSerializer**. No statically declared scalar field list was resolved; inspect the schema graph and pinned source.\n\n**Authorization:** no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access."},{"title":"partial_update · PATCH","body":"**PATCH /api/v1/plug_config/{slug}/** — action `partial_update`. static contract extracted; runtime/permission/payload behavior review pending.\n\nPath and deployment-context parameters:\n\n| Location | Parameter | Type | Required |\n| --- | --- | --- | --- |\n| path | slug | router lookup string; semantic ID validation requires handler/schema review | true |\n\n**serializer: PlugConfigSerializer**. No statically declared scalar field list was resolved; inspect the schema graph and pinned source.\n\n**Authorization:** no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access."},{"title":"destroy · DELETE","body":"**DELETE /api/v1/plug_config/{slug}/** — action `destroy`. static contract extracted; runtime/permission/payload behavior review pending.\n\nPath and deployment-context parameters:\n\n| Location | Parameter | Type | Required |\n| --- | --- | --- | --- |\n| path | slug | router lookup string; semantic ID validation requires handler/schema review | true |\n\n**serializer: PlugConfigSerializer**. No statically declared scalar field list was resolved; inspect the schema graph and pinned source.\n\n**Authorization:** no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access."},{"title":"Integration review checklist","body":"Confirm the installed route and full schema; review authentication, organization/facility scoping, all accepted fields, value-state and date/time semantics, idempotency, pagination, response/exception branches and the allowed correction/reversal workflow. Test positive and negative cases with synthetic data. This source reference does not establish external certification or replace an illustrated user procedure."}],"troubleshooting":[{"problem":"A declared route is unavailable or a request is rejected","solution":"Compare the installed revision, actual API schema, optional plugin mount, HTTP-method restrictions and recorded validation/permission evidence. Do not bypass a refusal or send a production transaction to test documentation."}],"sources":[{"path":"repositories/platform/mansoq-core/config/api_router.py","line":200,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/platform/mansoq-core/mansoq/users/api/viewsets/plug_config.py","line":10,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/platform/mansoq-core/mansoq/users/api/viewsets/plug_config.py","line":16,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/platform/mansoq-core/mansoq/users/api/viewsets/plug_config.py","line":41,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/platform/mansoq-core/mansoq/users/api/serializers/plug_config.py","line":6,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}],"related":["it-api-contract","it-api-auth","security-rcm-roles"],"verification":"Static API contract — behavior review pending","version":"f6e9f05f76d4","apiReferenceIds":["backend-resource-49187d8b64eee3f9","backend-resource-49187d8b64eee3f9:GET:list","backend-resource-49187d8b64eee3f9:POST:create","backend-resource-49187d8b64eee3f9:GET:retrieve","backend-resource-49187d8b64eee3f9:PUT:update","backend-resource-49187d8b64eee3f9:PATCH:partial_update","backend-resource-49187d8b64eee3f9:DELETE:destroy"]},"backend":{"resources":[{"id":"backend-resource-49187d8b64eee3f9","localPrefix":"plug_config","viewset":"PlugConfigViewset","classId":"repositories/platform/mansoq-core:mansoq.users.api.viewsets.plug_config.PlugConfigViewset","basename":"plug_configs","source":{"path":"repositories/platform/mansoq-core/config/api_router.py","line":200,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"conditions":[],"repository":"repositories/platform/mansoq-core","classSource":{"path":"repositories/platform/mansoq-core/mansoq/users/api/viewsets/plug_config.py","line":10,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"description":"","path":"/api/v1/plug_config/","mountStatus":"verified core mount in config/urls.py","operationIds":["backend-resource-49187d8b64eee3f9:GET:list","backend-resource-49187d8b64eee3f9:POST:create","backend-resource-49187d8b64eee3f9:GET:retrieve","backend-resource-49187d8b64eee3f9:PUT:update","backend-resource-49187d8b64eee3f9:PATCH:partial_update","backend-resource-49187d8b64eee3f9:DELETE:destroy"],"unresolvedViewset":false,"reviewStatus":"registered resource enumerated; behavioral review pending"}],"operations":[{"id":"backend-resource-49187d8b64eee3f9:GET:list","resourceId":"backend-resource-49187d8b64eee3f9","repository":"repositories/platform/mansoq-core","boundary":"primary-core","method":"GET","path":"/api/v1/plug_config/","declaredPattern":"/api/v1/plug_config/","action":"list","viewset":"PlugConfigViewset","classId":"repositories/platform/mansoq-core:mansoq.users.api.viewsets.plug_config.PlugConfigViewset","detail":false,"allowedByDeclaredHttpMethods":true,"mountStatus":"verified core mount in config/urls.py","routeEvidence":{"path":"repositories/platform/mansoq-core/config/api_router.py","line":200,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"handlerSource":{"path":"repositories/platform/mansoq-core/mansoq/users/api/viewsets/plug_config.py","line":16,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"registrationConditions":[],"evidenceKind":"declared/inherited method","methodEvidenceIds":["repositories/platform/mansoq-core/mansoq/users/api/viewsets/plug_config.py:16:list","repositories/platform/mansoq-core/mansoq/users/api/viewsets/plug_config.py:41:get_permissions"],"schemaIds":{"serializer":"repositories/platform/mansoq-core:mansoq.users.api.serializers.plug_config.PlugConfigSerializer"},"classPermissionEvidence":[],"filterEvidence":[],"reviewStatus":"static contract extracted; runtime/permission/payload behavior review pending","pathParameters":[]},{"id":"backend-resource-49187d8b64eee3f9:POST:create","resourceId":"backend-resource-49187d8b64eee3f9","repository":"repositories/platform/mansoq-core","boundary":"primary-core","method":"POST","path":"/api/v1/plug_config/","declaredPattern":"/api/v1/plug_config/","action":"create","viewset":"PlugConfigViewset","classId":"repositories/platform/mansoq-core:mansoq.users.api.viewsets.plug_config.PlugConfigViewset","detail":false,"allowedByDeclaredHttpMethods":true,"mountStatus":"verified core mount in config/urls.py","routeEvidence":{"path":"repositories/platform/mansoq-core/config/api_router.py","line":200,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"handlerSource":null,"registrationConditions":[],"evidenceKind":"standard external DRF mixin; library behavior review pending","methodEvidenceIds":[],"schemaIds":{"serializer":"repositories/platform/mansoq-core:mansoq.users.api.serializers.plug_config.PlugConfigSerializer"},"classPermissionEvidence":[],"filterEvidence":[],"reviewStatus":"static contract extracted; runtime/permission/payload behavior review pending","pathParameters":[]},{"id":"backend-resource-49187d8b64eee3f9:GET:retrieve","resourceId":"backend-resource-49187d8b64eee3f9","repository":"repositories/platform/mansoq-core","boundary":"primary-core","method":"GET","path":"/api/v1/plug_config/{slug}/","declaredPattern":"/api/v1/plug_config/{slug}/","action":"retrieve","viewset":"PlugConfigViewset","classId":"repositories/platform/mansoq-core:mansoq.users.api.viewsets.plug_config.PlugConfigViewset","detail":true,"allowedByDeclaredHttpMethods":true,"mountStatus":"verified core mount in config/urls.py","routeEvidence":{"path":"repositories/platform/mansoq-core/config/api_router.py","line":200,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"handlerSource":null,"registrationConditions":[],"evidenceKind":"standard external DRF mixin; library behavior review pending","methodEvidenceIds":[],"schemaIds":{"serializer":"repositories/platform/mansoq-core:mansoq.users.api.serializers.plug_config.PlugConfigSerializer"},"classPermissionEvidence":[],"filterEvidence":[],"reviewStatus":"static contract extracted; runtime/permission/payload behavior review pending","pathParameters":[{"name":"slug","in":"path","type":"router lookup string; semantic ID validation requires handler/schema review","required":true,"source":{"path":"repositories/platform/mansoq-core/config/api_router.py","line":200,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}]},{"id":"backend-resource-49187d8b64eee3f9:PUT:update","resourceId":"backend-resource-49187d8b64eee3f9","repository":"repositories/platform/mansoq-core","boundary":"primary-core","method":"PUT","path":"/api/v1/plug_config/{slug}/","declaredPattern":"/api/v1/plug_config/{slug}/","action":"update","viewset":"PlugConfigViewset","classId":"repositories/platform/mansoq-core:mansoq.users.api.viewsets.plug_config.PlugConfigViewset","detail":true,"allowedByDeclaredHttpMethods":true,"mountStatus":"verified core mount in config/urls.py","routeEvidence":{"path":"repositories/platform/mansoq-core/config/api_router.py","line":200,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"handlerSource":null,"registrationConditions":[],"evidenceKind":"standard external DRF mixin; library behavior review pending","methodEvidenceIds":[],"schemaIds":{"serializer":"repositories/platform/mansoq-core:mansoq.users.api.serializers.plug_config.PlugConfigSerializer"},"classPermissionEvidence":[],"filterEvidence":[],"reviewStatus":"static contract extracted; runtime/permission/payload behavior review pending","pathParameters":[{"name":"slug","in":"path","type":"router lookup string; semantic ID validation requires handler/schema review","required":true,"source":{"path":"repositories/platform/mansoq-core/config/api_router.py","line":200,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}]},{"id":"backend-resource-49187d8b64eee3f9:PATCH:partial_update","resourceId":"backend-resource-49187d8b64eee3f9","repository":"repositories/platform/mansoq-core","boundary":"primary-core","method":"PATCH","path":"/api/v1/plug_config/{slug}/","declaredPattern":"/api/v1/plug_config/{slug}/","action":"partial_update","viewset":"PlugConfigViewset","classId":"repositories/platform/mansoq-core:mansoq.users.api.viewsets.plug_config.PlugConfigViewset","detail":true,"allowedByDeclaredHttpMethods":true,"mountStatus":"verified core mount in config/urls.py","routeEvidence":{"path":"repositories/platform/mansoq-core/config/api_router.py","line":200,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"handlerSource":null,"registrationConditions":[],"evidenceKind":"standard external DRF mixin; library behavior review pending","methodEvidenceIds":[],"schemaIds":{"serializer":"repositories/platform/mansoq-core:mansoq.users.api.serializers.plug_config.PlugConfigSerializer"},"classPermissionEvidence":[],"filterEvidence":[],"reviewStatus":"static contract extracted; runtime/permission/payload behavior review pending","pathParameters":[{"name":"slug","in":"path","type":"router lookup string; semantic ID validation requires handler/schema review","required":true,"source":{"path":"repositories/platform/mansoq-core/config/api_router.py","line":200,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}]},{"id":"backend-resource-49187d8b64eee3f9:DELETE:destroy","resourceId":"backend-resource-49187d8b64eee3f9","repository":"repositories/platform/mansoq-core","boundary":"primary-core","method":"DELETE","path":"/api/v1/plug_config/{slug}/","declaredPattern":"/api/v1/plug_config/{slug}/","action":"destroy","viewset":"PlugConfigViewset","classId":"repositories/platform/mansoq-core:mansoq.users.api.viewsets.plug_config.PlugConfigViewset","detail":true,"allowedByDeclaredHttpMethods":true,"mountStatus":"verified core mount in config/urls.py","routeEvidence":{"path":"repositories/platform/mansoq-core/config/api_router.py","line":200,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"handlerSource":null,"registrationConditions":[],"evidenceKind":"standard external DRF mixin; library behavior review pending","methodEvidenceIds":[],"schemaIds":{"serializer":"repositories/platform/mansoq-core:mansoq.users.api.serializers.plug_config.PlugConfigSerializer"},"classPermissionEvidence":[],"filterEvidence":[],"reviewStatus":"static contract extracted; runtime/permission/payload behavior review pending","pathParameters":[{"name":"slug","in":"path","type":"router lookup string; semantic ID validation requires handler/schema review","required":true,"source":{"path":"repositories/platform/mansoq-core/config/api_router.py","line":200,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}]}],"methodEvidence":[{"id":"repositories/platform/mansoq-core/mansoq/users/api/viewsets/plug_config.py:16:list","name":"list","owner":"repositories/platform/mansoq-core:mansoq.users.api.viewsets.plug_config.PlugConfigViewset","summary":"","source":{"path":"repositories/platform/mansoq-core/mansoq/users/api/viewsets/plug_config.py","line":16,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"signatureParameters":[],"parametersRead":[],"permissionChecks":[],"declaredErrors":[],"explicitResponseStatuses":[],"conditions":[],"schemaIds":[],"schemaUsages":[],"unconditionalRaise":false,"reviewStatus":"static declaration extracted; behavioral/security review pending"},{"id":"repositories/platform/mansoq-core/mansoq/users/api/viewsets/plug_config.py:41:get_permissions","name":"get_permissions","owner":"repositories/platform/mansoq-core:mansoq.users.api.viewsets.plug_config.PlugConfigViewset","summary":"","source":{"path":"repositories/platform/mansoq-core/mansoq/users/api/viewsets/plug_config.py","line":41,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"signatureParameters":[],"parametersRead":[],"permissionChecks":[],"declaredErrors":[],"explicitResponseStatuses":[],"conditions":[],"schemaIds":[],"schemaUsages":[],"unconditionalRaise":false,"reviewStatus":"static declaration extracted; behavioral/security review pending"}],"schemas":[{"id":"repositories/platform/mansoq-core:mansoq.users.api.serializers.plug_config.PlugConfigSerializer","name":"PlugConfigSerializer","source":{"path":"repositories/platform/mansoq-core/mansoq/users/api/serializers/plug_config.py","line":6,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"kind":"Python declared schema/model evidence","fields":[],"validation":[],"baseTypes":["serializers.ModelSerializer"],"reviewStatus":"declared fields extracted; runtime validation review pending","referencedSchemaIds":[]}],"frameworkSettings":[{"name":"DEFAULT_AUTHENTICATION_CLASSES","value":["config.authentication.CustomJWTAuthentication","config.authentication.CustomBasicAuthentication","rest_framework.authentication.SessionAuthentication","rest_framework.authentication.TokenAuthentication"],"source":{"path":"repositories/platform/mansoq-core/config/settings/base.py","line":372,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"scope":"source default; deployment overrides and action-level policies may differ"},{"name":"DEFAULT_PERMISSION_CLASSES","value":["rest_framework.permissions.IsAuthenticated","mansoq.security.utils.permission_class.MansoqAuthentication"],"source":{"path":"repositories/platform/mansoq-core/config/settings/base.py","line":372,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"scope":"source default; deployment overrides and action-level policies may differ"},{"name":"DEFAULT_PAGINATION_CLASS","value":"mansoq.utils.pagination.mansoq_pagination.MansoqLimitOffsetPagination","source":{"path":"repositories/platform/mansoq-core/config/settings/base.py","line":372,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"scope":"source default; deployment overrides and action-level policies may differ"},{"name":"PAGE_SIZE","value":14,"source":{"path":"repositories/platform/mansoq-core/config/settings/base.py","line":372,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"scope":"source default; deployment overrides and action-level policies may differ"}]},"frontend":{"operations":[],"schemas":[]},"services":{"operations":[]},"boundaries":[]}