syntax = "proto3";

package atlas.resource.v1;

import "protoc-gen-openapiv2/options/annotations.proto";

option go_package = "github.com/infobloxopen/atlas-app-toolkit/atlas/resource;resource";

// A number of application services require a mechanism to
// encode the identity of a particular resource across applications.
// The resource identifiers consist of the application ID,
// an application-defined resource type,
// and an application-defined ID for that resource
message Identifier {
    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = {
        json_schema: {
            type: STRING;
            // TODO: update to correct name atlas.resource.v1.Identifier
            description: "atlas.rpc.Identifier";
        };
    };

    // An application identifier that will be used among
    // other infrastructure services to identify the application
    string application_name = 1;

    // An application specific type name of a resource
    string resource_type = 2;

    // An application specific resource identity of a resource
    string resource_id = 3;
}