Skip to content

Commit f4ebd17

Browse files
phlogistonjohnphlogistonjohn
committed
docs: generate api status data for admin/smb
Signed-off-by: John Mulligan <[email protected]>
1 parent 93343a1 commit f4ebd17

File tree

2 files changed

+438
-0
lines changed

2 files changed

+438
-0
lines changed

‎docs/api-status.json

Lines changed: 370 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2410,5 +2410,375 @@
24102410
"became_stable_version": "v0.31.0"
24112411
}
24122412
]
2413+
},
2414+
"common/admin/smb": {
2415+
"preview_api": [
2416+
{
2417+
"name": "NewFromConn",
2418+
"comment": "NewFromConn creates an new management object from a preexisting\nrados connection. The existing connection can be rados.Conn or any\ntype implementing the RadosCommander interface.\n",
2419+
"added_in_version": "$NEXT_RELEASE",
2420+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2421+
},
2422+
{
2423+
"name": "SimplePlacement",
2424+
"comment": "SimplePlacement returns a placement with common placement parameters - count\nand label - specified.\n",
2425+
"added_in_version": "$NEXT_RELEASE",
2426+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2427+
},
2428+
{
2429+
"name": "Cluster.Type",
2430+
"comment": "Type returns a ResourceType value.\n",
2431+
"added_in_version": "$NEXT_RELEASE",
2432+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2433+
},
2434+
{
2435+
"name": "Cluster.Intent",
2436+
"comment": "Intent controls if a resource is to be created/updated or removed.\n",
2437+
"added_in_version": "$NEXT_RELEASE",
2438+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2439+
},
2440+
{
2441+
"name": "Cluster.Identity",
2442+
"comment": "Identity returns a ResourceRef identifying this cluster.\n",
2443+
"added_in_version": "$NEXT_RELEASE",
2444+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2445+
},
2446+
{
2447+
"name": "Cluster.MarshalJSON",
2448+
"comment": "MarshalJSON supports marshalling a cluster to JSON.\n",
2449+
"added_in_version": "$NEXT_RELEASE",
2450+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2451+
},
2452+
{
2453+
"name": "Cluster.Validate",
2454+
"comment": "Validate returns an error describing an issue with the resource or\nnil if the resource object is valid.\n",
2455+
"added_in_version": "$NEXT_RELEASE",
2456+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2457+
},
2458+
{
2459+
"name": "Cluster.SetPlacement",
2460+
"comment": "SetPlacement modifies a cluster's placment settings.\n",
2461+
"added_in_version": "$NEXT_RELEASE",
2462+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2463+
},
2464+
{
2465+
"name": "NewUserCluster",
2466+
"comment": "NewUserCluster returns a new Cluster with default values set to\ncreate/update a cluster with local users-and-groups defined.\nIn addition to the cluster name, this function accepts zero or more\nID values naming ceph.smb.usersgroups resources.\n",
2467+
"added_in_version": "$NEXT_RELEASE",
2468+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2469+
},
2470+
{
2471+
"name": "NewActiveDirectoryCluster",
2472+
"comment": "NewActiveDirectoryCluster returns a new Cluster with default values set to\ncreate/update a cluster with active directory authentication.\nIn addition to the cluster name, this function accepts the name of the\ndomain/realm and zero or more ID values naming ceph.smb.join.auth resources.\n",
2473+
"added_in_version": "$NEXT_RELEASE",
2474+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2475+
},
2476+
{
2477+
"name": "NewClusterToRemove",
2478+
"comment": "NewClusterToRemove return a new Cluster with default values set to remove a\ncluster from management.\n",
2479+
"added_in_version": "$NEXT_RELEASE",
2480+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2481+
},
2482+
{
2483+
"name": "JoinAuth.Type",
2484+
"comment": "Type returns a ResourceType value.\n",
2485+
"added_in_version": "$NEXT_RELEASE",
2486+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2487+
},
2488+
{
2489+
"name": "JoinAuth.Intent",
2490+
"comment": "Intent controls if a resource is to be created/updated or removed.\n",
2491+
"added_in_version": "$NEXT_RELEASE",
2492+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2493+
},
2494+
{
2495+
"name": "JoinAuth.Identity",
2496+
"comment": "Identity returns a ResourceRef identifying this joinauth resource.\n",
2497+
"added_in_version": "$NEXT_RELEASE",
2498+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2499+
},
2500+
{
2501+
"name": "JoinAuth.Validate",
2502+
"comment": "Validate returns an error describing an issue with the resource or nil if\nthe resource object is valid.\n",
2503+
"added_in_version": "$NEXT_RELEASE",
2504+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2505+
},
2506+
{
2507+
"name": "JoinAuth.MarshalJSON",
2508+
"comment": "MarshalJSON supports marshalling a cluster to JSON.\n",
2509+
"added_in_version": "$NEXT_RELEASE",
2510+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2511+
},
2512+
{
2513+
"name": "JoinAuth.SetAuth",
2514+
"comment": "SetAuth modifies a JoinAuth's authentication values.\n",
2515+
"added_in_version": "$NEXT_RELEASE",
2516+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2517+
},
2518+
{
2519+
"name": "NewJoinAuth",
2520+
"comment": "NewJoinAuth returns a new JoinAuth with default values.\n",
2521+
"added_in_version": "$NEXT_RELEASE",
2522+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2523+
},
2524+
{
2525+
"name": "NewLinkedJoinAuth",
2526+
"comment": "NewLinkedJoinAuth returns a new JoinAuth with default values that link the\nresource to a particular cluster. Linked resources can only be used by the\ncluster they link to and are automatically deleted when the linked cluster\nis deleted.\n",
2527+
"added_in_version": "$NEXT_RELEASE",
2528+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2529+
},
2530+
{
2531+
"name": "NewJoinAuthToRemove",
2532+
"comment": "NewJoinAuthToRemove returns a new JoinAuth with default values set to remove\nthe join auth resource from management.\n",
2533+
"added_in_version": "$NEXT_RELEASE",
2534+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2535+
},
2536+
{
2537+
"name": "ResourceType.Type",
2538+
"comment": "Type returns a ResourceType value.\n",
2539+
"added_in_version": "$NEXT_RELEASE",
2540+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2541+
},
2542+
{
2543+
"name": "ResourceType.String",
2544+
"comment": "String returns a string value referring to a resource.\n",
2545+
"added_in_version": "$NEXT_RELEASE",
2546+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2547+
},
2548+
{
2549+
"name": "ResourceID.Type",
2550+
"comment": "Type returns a ResourceType value.\n",
2551+
"added_in_version": "$NEXT_RELEASE",
2552+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2553+
},
2554+
{
2555+
"name": "ResourceID.String",
2556+
"comment": "String returns a string value referring to a resource.\n",
2557+
"added_in_version": "$NEXT_RELEASE",
2558+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2559+
},
2560+
{
2561+
"name": "ChildResourceID.Type",
2562+
"comment": "Type returns a ResourceType value.\n",
2563+
"added_in_version": "$NEXT_RELEASE",
2564+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2565+
},
2566+
{
2567+
"name": "ChildResourceID.String",
2568+
"comment": "String returns a string value referring to a resource.\n",
2569+
"added_in_version": "$NEXT_RELEASE",
2570+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2571+
},
2572+
{
2573+
"name": "Admin.Show",
2574+
"comment": "Show smb module resource descriptions stored on the Ceph cluster.\nIf any values are provided in the refs slice, the function will query\nonly resources matching those references. These may be all matching\nresources of a type or more specific references with IDs. The opts value\ncan be nil for default behavior or supplied to customize the query results.\nCurrently, ShowOptions can be used to filter password values.\n\nSimilar To:\n\n\tceph smb show\n",
2575+
"added_in_version": "$NEXT_RELEASE",
2576+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2577+
},
2578+
{
2579+
"name": "Admin.Apply",
2580+
"comment": "Apply changes to the resource descriptions stored on the Ceph cluster.\nSupply one or more Resource objects in the slice and these resources will\nbe created, updated, or removed based on the Resource's parameters.\nAn Intent() of Present will create or update a resource.\nAn Intent() of Removed will remove a matching resource or be a no-op if nothing\nis matched.\nThe opts value can be nil for default behavior or supplied to customize the\nway the command processes inputs and outputs. Currently, the password values\nsupplied in the objects and returned in the result can be filtered depending\non the fields in the ApplyOptions structure.\n\nSimilar To:\n\n\tceph smb apply -i -\n",
2581+
"added_in_version": "$NEXT_RELEASE",
2582+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2583+
},
2584+
{
2585+
"name": "ValidateResources",
2586+
"comment": "ValidateResources in the supplied slice, returning an error if any\nresource is invalid or nil if all resources are valid. The first invalid resource\nwill be identified and described in the resulting error.\n",
2587+
"added_in_version": "$NEXT_RELEASE",
2588+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2589+
},
2590+
{
2591+
"name": "Admin.RemoveCluster",
2592+
"comment": "RemoveCluster will remove a Cluster resource with a matching ID value\nfrom the Ceph cluster. This is a convenience function that creates a\nCluster resource to remove and then applies it in one step.\n",
2593+
"added_in_version": "$NEXT_RELEASE",
2594+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2595+
},
2596+
{
2597+
"name": "Admin.RemoveShare",
2598+
"comment": "RemoveShare will remove a Share resource with matching ID values from\nthe Ceph cluster. This is a convenience function that creates a Share\nresource to remove and then applies it in one step.\n",
2599+
"added_in_version": "$NEXT_RELEASE",
2600+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2601+
},
2602+
{
2603+
"name": "Admin.RemoveJoinAuth",
2604+
"comment": "RemoveJoinAuth will remove a JoinAuth resource with a matching ID value\nfrom the Ceph cluster. This is a convenience function that creates a\nJoinAuth resource to remove and then applies it in one step.\n",
2605+
"added_in_version": "$NEXT_RELEASE",
2606+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2607+
},
2608+
{
2609+
"name": "Admin.RemoveUsersAndGroups",
2610+
"comment": "RemoveUsersAndGroups will remove a UsersAndGroups resource with a matching\nID value from the Ceph cluster. This is a convenience function that creates\na UsersAndGroups resource to remove and then applies it in one step.\n",
2611+
"added_in_version": "$NEXT_RELEASE",
2612+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2613+
},
2614+
{
2615+
"name": "Result.UnmarshalJSON",
2616+
"comment": "UnmarshalJSON support unmarshalling JSON to a Result.\n",
2617+
"added_in_version": "$NEXT_RELEASE",
2618+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2619+
},
2620+
{
2621+
"name": "Result.Ok",
2622+
"comment": "Ok returns true if the resource modification was a success.\n",
2623+
"added_in_version": "$NEXT_RELEASE",
2624+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2625+
},
2626+
{
2627+
"name": "Result.Resource",
2628+
"comment": "Resource returns the resource changed.\n",
2629+
"added_in_version": "$NEXT_RELEASE",
2630+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2631+
},
2632+
{
2633+
"name": "Result.Message",
2634+
"comment": "Message returns an optional string describing the modification state.\n",
2635+
"added_in_version": "$NEXT_RELEASE",
2636+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2637+
},
2638+
{
2639+
"name": "Result.Error",
2640+
"comment": "Error supports treating a failed result as a Go error.\n",
2641+
"added_in_version": "$NEXT_RELEASE",
2642+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2643+
},
2644+
{
2645+
"name": "Result.State",
2646+
"comment": "State returns a short string describing the state of the resource.\n",
2647+
"added_in_version": "$NEXT_RELEASE",
2648+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2649+
},
2650+
{
2651+
"name": "Result.Dump",
2652+
"comment": "Dump additional fields returned with the result.\n",
2653+
"added_in_version": "$NEXT_RELEASE",
2654+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2655+
},
2656+
{
2657+
"name": "ResultGroup.Ok",
2658+
"comment": "Ok returns true if all the resource modifications were successful.\n",
2659+
"added_in_version": "$NEXT_RELEASE",
2660+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2661+
},
2662+
{
2663+
"name": "ResultGroup.ErrorResults",
2664+
"comment": "ErrorResults returns a slice of results containing items that were not\nsuccessful.\n",
2665+
"added_in_version": "$NEXT_RELEASE",
2666+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2667+
},
2668+
{
2669+
"name": "ResultGroup.Error",
2670+
"comment": "Error supports treating a failed ResultGroup as a Go error.\n",
2671+
"added_in_version": "$NEXT_RELEASE",
2672+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2673+
},
2674+
{
2675+
"name": "ShareAccess.Validate",
2676+
"comment": "Validate returns an error describing an issue with the share access object\nor nil if the object is valid.\n",
2677+
"added_in_version": "$NEXT_RELEASE",
2678+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2679+
},
2680+
{
2681+
"name": "Share.Type",
2682+
"comment": "Type returns a ResourceType value.\n",
2683+
"added_in_version": "$NEXT_RELEASE",
2684+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2685+
},
2686+
{
2687+
"name": "Share.Intent",
2688+
"comment": "Intent controls if a resource is to be created/updated or removed.\n",
2689+
"added_in_version": "$NEXT_RELEASE",
2690+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2691+
},
2692+
{
2693+
"name": "Share.Identity",
2694+
"comment": "Identity returns a ResourceRef identifying this share resource.\n",
2695+
"added_in_version": "$NEXT_RELEASE",
2696+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2697+
},
2698+
{
2699+
"name": "Share.MarshalJSON",
2700+
"comment": "MarshalJSON supports marshalling a Share resource to JSON.\n",
2701+
"added_in_version": "$NEXT_RELEASE",
2702+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2703+
},
2704+
{
2705+
"name": "Share.Validate",
2706+
"comment": "Validate returns an error describing an issue with the resource or nil if\nthe resource object is valid.\n",
2707+
"added_in_version": "$NEXT_RELEASE",
2708+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2709+
},
2710+
{
2711+
"name": "Share.SetCephFS",
2712+
"comment": "SetCephFS modifies a Share resource's CephFS storage parameters.\n",
2713+
"added_in_version": "$NEXT_RELEASE",
2714+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2715+
},
2716+
{
2717+
"name": "NewShare",
2718+
"comment": "NewShare returns a new Share resource object with default values.\n",
2719+
"added_in_version": "$NEXT_RELEASE",
2720+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2721+
},
2722+
{
2723+
"name": "NewShareToRemove",
2724+
"comment": "NewShareToRemove returns a new Share resource object with default values set\nto remove the share from management.\n",
2725+
"added_in_version": "$NEXT_RELEASE",
2726+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2727+
},
2728+
{
2729+
"name": "UsersAndGroups.Type",
2730+
"comment": "Type returns a ResourceType value.\n",
2731+
"added_in_version": "$NEXT_RELEASE",
2732+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2733+
},
2734+
{
2735+
"name": "UsersAndGroups.Intent",
2736+
"comment": "Intent controls if a resource is to be created/updated or removed.\n",
2737+
"added_in_version": "$NEXT_RELEASE",
2738+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2739+
},
2740+
{
2741+
"name": "UsersAndGroups.Identity",
2742+
"comment": "Identity returns a ResourceRef identifying this users and groups resource.\n",
2743+
"added_in_version": "$NEXT_RELEASE",
2744+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2745+
},
2746+
{
2747+
"name": "UsersAndGroups.Validate",
2748+
"comment": "Validate returns an error describing an issue with the resource or nil if\nthe resource object is valid.\n",
2749+
"added_in_version": "$NEXT_RELEASE",
2750+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2751+
},
2752+
{
2753+
"name": "UsersAndGroups.MarshalJSON",
2754+
"comment": "MarshalJSON supports marshalling a UsersAndGroups resource to JSON.\n",
2755+
"added_in_version": "$NEXT_RELEASE",
2756+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2757+
},
2758+
{
2759+
"name": "UsersAndGroups.SetValues",
2760+
"comment": "SetValues modifies a UsersAndGroups resource's users list and groups list.\n",
2761+
"added_in_version": "$NEXT_RELEASE",
2762+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2763+
},
2764+
{
2765+
"name": "NewUsersAndGroups",
2766+
"comment": "NewUsersAndGroups returns a new UsersAndGroups resource object with default\nvalues.\n",
2767+
"added_in_version": "$NEXT_RELEASE",
2768+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2769+
},
2770+
{
2771+
"name": "NewLinkedUsersAndGroups",
2772+
"comment": "NewLinkedUsersAndGroups returns a new UsersAndGroups resource object with\ndefault values that link the resource to a particular cluster. Linked\nresources can only be used by the cluster they link to and are automatically\ndeleted when the linked cluster is deleted.\n",
2773+
"added_in_version": "$NEXT_RELEASE",
2774+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2775+
},
2776+
{
2777+
"name": "NewUsersAndGroupsToRemove",
2778+
"comment": "NewUsersAndGroupsToRemove returns a new UsersAndGroups resource object with\ndefault values set to remove the users and groups resource from management.\n",
2779+
"added_in_version": "$NEXT_RELEASE",
2780+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2781+
}
2782+
]
24132783
}
24142784
}

0 commit comments

Comments
 (0)